home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetFloatMax.z / alGetFloatMax
Encoding:
Text File  |  1998-10-20  |  7.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((3333ddddmmmm))))                                          aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetFloatMax, alSetFloatMax - get/set the maximum value of floating
  10.      point sample data.
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      ddddoooouuuubbbblllleeee aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg))))
  16.      iiiinnnntttt aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg,,,, ddddoooouuuubbbblllleeee mmmmaaaaxxxxiiiimmmmuuuummmm____vvvvaaaalllluuuueeee))))
  17.  
  18. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  19.      _c_o_n_f_i_g          expects an AAAALLLLccccoooonnnnffffiiiigggg structure, the returned value of a
  20.                      call to aaaallllNNNNeeeewwwwCCCCoooonnnnffffiiiigggg((((3333ddddmmmm)))) or aaaallllGGGGeeeettttCCCCoooonnnnffffiiiigggg((((3333ddddmmmm)))).
  21.  
  22.      _m_a_x_i_m_u_m__v_a_l_u_e   expects an IEEE double precision floating point value
  23.                      which defines the range of the floating point data for
  24.                      the aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) or aaaallllWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) functions.
  25.  
  26. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.      aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx simultaneously sets the upper and lower bounds of the data
  28.      read from a port with the aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) function or written with the
  29.      aaaallllWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) function. This is only meaningful if the sample format
  30.      is single- or double-precision floating-point; see aaaallllSSSSeeeettttSSSSaaaammmmppppFFFFmmmmtttt((((3333ddddmmmm)))) for
  31.      more information.
  32.  
  33.      The data transferred into a program with aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) will be scaled
  34.      to the range (-_m_a_x_i_m_u_m__v_a_l_u_e, _m_a_x_i_m_u_m__v_a_l_u_e), where the maximum value of
  35.      the input data (32767 in the case of 16-bit input) will correspond to
  36.      _m_a_x_i_m_u_m__v_a_l_u_e.  Likewise, the value -32768 will correspond to
  37.      -_m_a_x_i_m_u_m__v_a_l_u_e in this case.
  38.  
  39.      Data output with aaaallllWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) or aaaallllWWWWrrrriiiitttteeeeBBBBuuuuffffffffeeeerrrrssss((((3333ddddmmmm)))) should fall in
  40.      the range (-_m_a_x_i_m_u_m__v_a_l_u_e, _m_a_x_i_m_u_m__v_a_l_u_e). Normally, the AL will
  41.      automatically limit output to this range; however, this can be disabled
  42.      with aaaallllSSSSeeeettttLLLLiiiimmmmiiiittttiiiinnnngggg((((3333ddddmmmm)))) if the application knows its data is always in
  43.      range.
  44.  
  45.      aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx is only meaningful when the sample format for _c_o_n_f_i_g is set
  46.      to AAAALLLL____SSSSAAAAMMMMPPPPFFFFMMMMTTTT____FFFFLLLLOOOOAAAATTTT or AAAALLLL____SSSSAAAAMMMMPPPPFFFFMMMMTTTT____DDDDOOOOUUUUBBBBLLLLEEEE.  See aaaallllSSSSeeeettttSSSSaaaammmmppppFFFFmmmmtttt((((3333ddddmmmm)))) for more
  47.      details regarding setting the sample data format.
  48.  
  49.      aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx returns the current value of the floating-point scale in
  50.      _c_o_n_f_i_g.
  51.  
  52. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  53.      Upon successful completion, aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx returns 0. Otherwise,
  54.      aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx returns -1 and sets an error number which can be retrieved
  55.      with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  56.  
  57.      aaaallllSSSSeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx can fail for the following reasons:
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((3333ddddmmmm))))                                          aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG     _c_o_n_f_i_g is invalid or null.
  75.  
  76.      AAAALLLL____BBBBAAAADDDD____FFFFLLLLOOOOAAAATTTTMMMMAAAAXXXX   _m_a_x_i_m_u_m__v_a_l_u_e is zero.
  77.  
  78.      aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx returns 0 in the case of failure and sets an error number
  79.      which can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))). When successful, aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx
  80.      returns the (strictly positive) current value of the floating-point scale
  81.      in _c_o_n_f_i_g.
  82.  
  83.      aaaallllGGGGeeeettttFFFFllllooooaaaattttMMMMaaaaxxxx can fail for the following reason:
  84.  
  85.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG   _c_o_n_f_i_g is invalid or null.
  86.  
  87. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  88.      alNewConfig(3dm), alGetConfig(3dm), alOpenPort(3dm), alSetConfig(3dm),
  89.      alSetSampFmt(3dm), alSetLimiting(3dm), oserror(3C)
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.